home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / audio / ALgetwidth.z / ALgetwidth
Encoding:
Text File  |  1998-10-20  |  6.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm))))                                                AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ALsetwidth, ALgetwidth - (obsolete) get/set the sample width setting in
  10.      an audio AAAALLLLccccoooonnnnffffiiiigggg structure
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      lllloooonnnngggg AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg))))
  16.  
  17.      iiiinnnntttt AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg,,,, lllloooonnnngggg ssssaaaammmmpppplllleeeessssiiiizzzzeeee))))
  18.  
  19. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  20.      _c_o_n_f_i_g       expects an AAAALLLLccccoooonnnnffffiiiigggg structure, the returned value of a call
  21.                   to AAAALLLLnnnneeeewwwwccccoooonnnnffffiiiigggg((((3333ddddmmmm)))) or AAAALLLLggggeeeettttccccoooonnnnffffiiiigggg((((3333ddddmmmm)))).
  22.  
  23.      _s_a_m_p_l_e_s_i_z_e   expects a symbolic constant that identifies the size of an
  24.                   audio sample.  There are three symbolic constants defined
  25.                   for this parameter.
  26.  
  27.                   AAAALLLL____SSSSAAAAMMMMPPPPLLLLEEEE____8888 indicates a one byte sample width in the range
  28.                   -128 to 127.
  29.  
  30.                   AAAALLLL____SSSSAAAAMMMMPPPPLLLLEEEE____11116666 indicates a two byte sample width in the range
  31.                   -32768 to 32767.
  32.  
  33.                   AAAALLLL____SSSSAAAAMMMMPPPPLLLLEEEE____22224444 indicates a 4 byte sample width in the range
  34.                   -8388608 to 8388607.
  35.  
  36. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  37.      AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh and AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh are obsolete and are provided for backward
  38.      compatibility. The preferred functions are aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh((((3333ddddmmmm)))) and
  39.      aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh((((3333ddddmmmm)))).
  40.  
  41.      AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) sets the sample width setting in the AAAALLLLccccoooonnnnffffiiiigggg structure
  42.      _c_o_n_f_i_g.  Any audio port that you then configure using _c_o_n_f_i_g will have
  43.      the audio sample size you specify with _s_a_m_p_l_e_s_i_z_e.
  44.  
  45.      AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) can fail for the following reasons:
  46.  
  47.      AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG   _c_o_n_f_i_g is invalid or null.
  48.  
  49.      AAAALLLL____BBBBAAAADDDD____WWWWIIIIDDDDTTTTHHHH    _w_i_d_t_h is not one of the valid constants listed above.
  50.  
  51.      AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) returns the current sample width setting in the AAAALLLLccccoooonnnnffffiiiigggg
  52.      structure _c_o_n_f_i_g.
  53.  
  54.      AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) can fail for the following reason:
  55.  
  56.      AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG    _c_o_n_f_i_g is invalid or null.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm))))                                                AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      Both AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) and AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) are meaningful if you are using
  75.      the two's complement sample format (the default). If you are using
  76.      floating point data (see AAAALLLLsssseeeettttssssaaaammmmppppffffmmmmtttt((((3333ddddmmmm))))), calls to AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm))))
  77.      will not affect the behavior of AAAALLLLrrrreeeeaaaaddddssssaaaammmmppppssss((((3333ddddmmmm)))) or AAAALLLLwwwwrrrriiiitttteeeessssaaaammmmppppssss((((3333ddddmmmm))))
  78.      until you switch to two's complement sample format.
  79.  
  80. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  81.      Upon successful completion AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) returns a long whose value is
  82.      one of the symbolic constants described above for _s_a_m_p_l_e_s_i_z_e. Otherwise,
  83.      AAAALLLLggggeeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) returns -1 and and sets an error number. This error
  84.      number can be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  85.  
  86.      AAAALLLLsssseeeettttwwwwiiiiddddtttthhhh((((3333ddddmmmm)))) returns 0 to the calling process when successful.
  87.      Otherwise, it returns -1 and sets an error number as described above.
  88.  
  89. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  90.      ALnewconfig(3dm), ALgetconfig(3dm), ALopenport(3dm), ALsetconfig(3dm),
  91.      oserror(3C)
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.